Skip to content

Added Subscribers and Notifications pages#439

Merged
sriramveeraghanta merged 4 commits intomasterfrom
add-subscribers-and-notifications
Apr 24, 2026
Merged

Added Subscribers and Notifications pages#439
sriramveeraghanta merged 4 commits intomasterfrom
add-subscribers-and-notifications

Conversation

@danciaclara
Copy link
Copy Markdown
Collaborator

@danciaclara danciaclara commented Apr 23, 2026

Description

Type of Change

  • Bug fix (non-breaking change which fixes an issue)
  • Feature (non-breaking change which adds functionality)
  • Improvement (change that would cause existing functionality to not work as expected)
  • Code refactoring
  • Performance improvements
  • Documentation update

Screenshots and Media (if applicable)

Test Scenarios

References

Summary by CodeRabbit

  • Documentation
    • Reorganized communication-related documentation under new "Communication and Collaboration" section
    • Added comprehensive guides for Notifications and Subscribers features
    • Expanded Inbox documentation with detailed notification management instructions
    • Updated feature availability indicator for due date reminders (now Enterprise Grid)

@vercel
Copy link
Copy Markdown

vercel Bot commented Apr 23, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Apr 23, 2026 9:14pm

Request Review

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 23, 2026

Warning

Rate limit exceeded

@danciaclara has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 50 minutes and 23 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 50 minutes and 23 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: a327f84e-f373-4e14-95b2-e8a6133924ad

📥 Commits

Reviewing files that changed from the base of the PR and between f045d76 and 7cd8419.

📒 Files selected for processing (4)
  • docs/communication-and-collaboration/inbox.md
  • docs/communication-and-collaboration/notifications.md
  • docs/communication-and-collaboration/subscribers.md
  • docs/core-concepts/account/settings.md
📝 Walkthrough

Walkthrough

Reorganize documentation by moving Inbox from "core-concepts" to new "communication-and-collaboration" section. Add two new documentation pages (Notifications and Subscribers), update sidebar navigation with new grouping label and links, modify a badge styling in automations documentation, and configure a URL redirect for backward compatibility.

Changes

Cohort / File(s) Summary
Sidebar Navigation Configuration
docs/.vitepress/config.ts
Updated sidebar grouping label from "Collaboration" to "Communication", changed Inbox link path from core-concepts/inbox to communication-and-collaboration/inbox, and added two new sidebar links for Subscribers and Notifications under the communication section.
Inbox Documentation Migration
docs/core-concepts/inbox.md, docs/communication-and-collaboration/inbox.md
Removed original inbox documentation from core-concepts and created expanded replacement page at communication-and-collaboration with comprehensive details on notification management, filtering, snoozing, archiving, and stacked notification grouping.
New Communication & Collaboration Pages
docs/communication-and-collaboration/notifications.md, docs/communication-and-collaboration/subscribers.md
Added two new documentation pages explaining notification generation, channels, preferences, and delivery; and describing subscription workflows, bulk subscription management, auto-subscription rules, and feature tier gating (Pro/Enterprise Grid).
Automations Documentation
docs/automations/overview.md
Changed badge for "Set up due date reminders" section from tip style with "Business" text to warning style with "Enterprise Grid" text, updating feature availability indicator.
URL Redirect Configuration
vercel.json
Added redirect rule to forward requests from /core-concepts/inbox to /communication-and-collaboration/inbox for backward compatibility.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Poem

🐰 Docs reorganized with bunny care,
Inbox hops to Communication's lair,
Subscribers dance and Notifications gleam,
New pages sprouting, living the dream,
A warren of knowledge, organized supreme! 📚

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: it adds two new documentation pages for Subscribers and Notifications under the communication-and-collaboration section, along with supporting structural updates.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch add-subscribers-and-notifications

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Copy Markdown

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 6

🧹 Nitpick comments (1)
docs/.vitepress/config.ts (1)

530-547: Sidebar updates align with new routes; consider group label wording.

The retarget of Inbox to /communication-and-collaboration/inbox and the two new entries correctly mirror the files added in this PR and the vercel.json redirect.

One optional nit: the group label was trimmed from "Collaboration" to just "Communication", but the URL segment is communication-and-collaboration/ and some items listed under it (e.g., Page Inline Comments, Work Item Comments) are collaboration features. If the rename was deliberate, ignore this; otherwise "Communication and collaboration" would better reflect the URL namespace and contents.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@docs/.vitepress/config.ts` around lines 530 - 547, The sidebar group
currently labeled with the text property "Communication" should be updated to
"Communication and collaboration" to match the URL namespace and included items;
locate the nav/group object where text: "Communication" is defined in the
docs/.vitepress/config.ts and change that text value to "Communication and
collaboration" so the label aligns with the communication-and-collaboration/
routes and entries like "Work Item Comments" and "Page Inline Comments".
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@docs/communication-and-collaboration/inbox.md`:
- Line 10: The sentence in the docs line about the inbox is truncated ("when
either tab h"); update the sentence in
docs/communication-and-collaboration/inbox.md to complete the phrase—for
example: "The sidebar icon shows a red dot when either tab has unread items"—so
the user-facing content reads as a full, grammatical sentence referencing the
inbox tabs (All and Mentions) and the sidebar icon behavior.

In `@docs/communication-and-collaboration/notifications.md`:
- Around line 30-44: The table header "Notifies subscribers?" is misleading
because several rows (e.g., `@mention`, Due date approaching, and general event
rows that notify assignees/creators) notify recipients beyond just subscribers;
rename the header to a neutral term like "Notifies?" or "Recipients" and update
any affected rows (for example the "@mention" row and "Due date approaching
(reminder)" row) so the column accurately reflects who is notified (e.g., "Yes —
mentioned user; auto-subscribes" or "Yes — subscribers and assignees") and
ensure the "Who gets notified" explanatory section aligns with the new header
wording.
- Line 98: The sentence ending with the cross-link "See [Set up due date
reminders](/automations/overview#set-up-due-date-reminders)" is missing a
terminal period; update that sentence (the line that currently reads "See [Set
up due date reminders](/automations/overview#set-up-due-date-reminders)") to
include a closing period so it ends with "...#set-up-due-date-reminders).".

In `@docs/communication-and-collaboration/subscribers.md`:
- Line 60: The badge text "Enterprise Grid" and the trailing note "This feature
requires the Enterprise plan and is only accessible to Project Admins." are
inconsistent; pick one SKU name and make both places match. Update the trailing
sentence to use "Enterprise Grid" (or change the badge to "Enterprise plan" if
that is the canonical term) so the badge at the top and the trailing note use
the identical phrase; ensure any nearby gating text that references the same SKU
(e.g., the similar gating on line 46 / automations overview) is updated to the
same chosen term as well.
- Around line 1-6: The frontmatter title currently reads `title: Subscriptions`
but the page H1 is `# Subscribers` (and the sidebar label is "Subscribers");
update the frontmatter `title` value to "Subscribers" so the <title> tag and
navigation match the H1/sidebar. Ensure the frontmatter `title` key is changed
to "Subscribers" to keep headings and sidebar labels consistent (no other
content changes required).
- Line 56: The sentence fragment "New work items they'll be subscribed to
automatically at creation." is awkward; replace it with a complete sentence such
as "They will be subscribed to new work items automatically when those items are
created." Locate the sentence following "When you add someone as a project
subscriber, Plane subscribes them to all current work items in the project in
the background." and update that fragment to the suggested full sentence so the
paragraph reads fluently.

---

Nitpick comments:
In `@docs/.vitepress/config.ts`:
- Around line 530-547: The sidebar group currently labeled with the text
property "Communication" should be updated to "Communication and collaboration"
to match the URL namespace and included items; locate the nav/group object where
text: "Communication" is defined in the docs/.vitepress/config.ts and change
that text value to "Communication and collaboration" so the label aligns with
the communication-and-collaboration/ routes and entries like "Work Item
Comments" and "Page Inline Comments".
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 3ad21bce-c672-43d2-bfaf-7c438c7fce11

📥 Commits

Reviewing files that changed from the base of the PR and between e4b52b5 and f045d76.

📒 Files selected for processing (7)
  • docs/.vitepress/config.ts
  • docs/automations/overview.md
  • docs/communication-and-collaboration/inbox.md
  • docs/communication-and-collaboration/notifications.md
  • docs/communication-and-collaboration/subscribers.md
  • docs/core-concepts/inbox.md
  • vercel.json
💤 Files with no reviewable changes (1)
  • docs/core-concepts/inbox.md

Comment thread docs/communication-and-collaboration/inbox.md Outdated
Comment thread docs/communication-and-collaboration/notifications.md Outdated
Comment thread docs/communication-and-collaboration/notifications.md Outdated
Comment thread docs/communication-and-collaboration/subscribers.md
Comment thread docs/communication-and-collaboration/subscribers.md Outdated
Comment thread docs/communication-and-collaboration/subscribers.md Outdated
@sriramveeraghanta sriramveeraghanta merged commit 6e97b2b into master Apr 24, 2026
5 checks passed
@sriramveeraghanta sriramveeraghanta deleted the add-subscribers-and-notifications branch April 24, 2026 04:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants